Add llms.txt with sphinx-llm #642
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
Some preview URLs:
The EC2 page is a nice example because it uses custom extensions like tab groups and version templating. The markdown renders prefectly. Any of the workflow examples are nice too because their source format is a Jupyter notebook. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I just fixed a build bug in
sphinx-llmwhich was affecting this repo, so now with0.1.4things build successfully.In one of the extensions I was making use of some private jinja2 rendering functionality in the HTML builder which doesn't seem to exist in the markdown builder, so I also updated the extension to just use jinja2 directly.
If you look at the build preview you should be able to view
llms.txt,llms-full.txtand append.mdto any page URL for a markdown represenation.Because we build with
dirhtmlthe URL might be something like/cloud/aws/ec2/, there's an assumedindex.htmlfile in there so the transformation would be/cloud/aws/ec2/=>/cloud/aws/ec2/index.html.md